Get Customer Online PSTN Gateway

The Get Customer Online PSTN Gateway request retrieves Online PSTN gateway that has been attached to a customer service.

URI

Copy 
{{baseUrl}}/api/v3/customer/{customerGuid}/onlinepstngateway

HTTP Method

GET

Request Parameters

Parameter

Type

Description

customerGuid

string ($uuid)

umpCustomerGuid created in the Live Platformcustomer tenant SQL database :

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

Example Response

Copy 

            

HTTP Responses

■ 200 OK

Parameter

Type

Description

Id

string($uuid)

'umpCustomerGuid' value created in the Live Platformcustomer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

shortName

string

Short name of service complying with the following validation rules:

■ The string should be 3-15 characters long
■ The following characters cannot be used: \ / : * ? " < > |audit
■ Can contain letters (lower/UPPER case), Numbers and special characters are allowed, however cannot contain the dot (.) or blank spaces.
■ Unique name per M365 Tenant

fullName

string

The customer full name defined in the customer's Operator Connect JSON file.

licenseType

integer Enum:

[3, 4, 5]

[ 0, 1, 2]

One of the following values:

■ Hosted Essentials: 0
■ Hosted Essential Plus: 1
■ Hosted Pro: 2
■ OC Essential: 3
■ OC Essential Plus: 4
■ OC Pro: 5

licensedUsersCount

integer

Number of licensed users.

msTenantId

string

Microsoft subscription Tenant ID of the customer attached to the service.

siteLocation (SIP Connection)

Array including the following:

■ id: string($uuid)
■ name: string
■ sbcId: integer
■ sbcDeploymentState: string

The configured SBC used to manage calls for this SIP Connection.

id

string($uuid)

The unique id for the SIP Connection (site location). Equivalent to value 'siteGuid' created when adding the SIP Connection.

name

string

Name of the SIP Connection.

sbcId

integer

Id of the SBC device in the Live Platform SQL database (see Get SBC Devices.

sbcdeploymentState

string

Deployment state of the tenant. One of the following values:

■ Draft=0
■ Submitted=1
■ Deploying=2
■ Deployed=3
■ Error=4
■ ReadyForDeployment=5
■ ReadyForRemove=6
■ Removing=7
■ Removed=8
■ 500 Internal Server Error:
Copy 
{
"title": "Failed to retrieve customer information",
"status": 500,
"detail": "ErrorTicket=9ce0708c-9de2-44c9-9daf-0aa81b90bd76"
}